Tootsville::Infinity-End-Event

Function

Infinity-End-Event names a function, with lambda list (D USER RECIPIENT/S):

Attempt to end an event.

End an event begun by TOOTSVILLE INFINITY-START-EVENT, q.v.

End an event begun by TOOTSVILLE INFINITY-START-EVENT, q.v.

Lisp END-EVENT = JSON endEvent

Calling

{ c: "endEvent",
  d: { moniker: "event moniker",
       ( id | eventID ): "event ID",
       status: ( "cmp" | "cxl" ),
       [ medal: "medal", ]
       [ score: "score" ] } }

This command terminates an event (such as a fountain, store purchase, or minigame) which was begun with TOOTSVILLE INFINITY-START-EVENT, qv.

The parameter eventID can be referenced as id instead --- but that is deprecated (since Romance 1.0) and will (eventually) be dropped.

The status code is either cmp, if the event was completed in some way (successfully or otherwise), or cxl, if the event was canceled before it reached any ind of completion.

The score and medal parameters are optional, and depend on the type of event. They should never be submitted with a cxl cancel packet, and are not needed for an item purchase. They are sometimes to be used with minigames. The score has a special relationship with magic fountains, described below.

• In the event of a magic fountain, the client should submit a random number between 1 and 100 as the score. This will be ignored, and a number of peanuts will be awarded to the player.

• In the event of a purchase, neither score nor medal are required.

• Other kinds of events can pass a numeric score, or a string for medal, as appropriate to their needs.

Success Response to Canceled Event

The response to a canceled (status: "cxl") event will be of the form:

{ from: "endEvent",
  status: true,
  ended: "eventID",
  canceled: true }

Success Response to Completed Event

The response to a completed (status: "cmp") event will be of the form:

{ from: "endEvent",
  status: true,
  ended: "eventID",
  peanuts: peanuts,
  fairyDust: fairyDust,
  [ highScores: { 1: { points: points,
                       userName: "user name" },
                  2: ... 24: }, ]
  totalPeanuts: total,
  totalFairyDust: total,
  [ gotHighScore: index ]

The endEvent packet for a completed event indicates:

• The event ID which was ended --- typically a UUID. This matches the eventID returned by startEvent and passed back to endEvent.

• The relative change in peanuts and fairy dust (positive means more earned; negative means a net loss), and the player's new totals of each

• If the event is a minigame or other event that could have a high score list, up to 24 top scores are returned, each with a point score, an user name, and (if the event is that sort) possibly a medal earned. Note that it is possible to get fewer than 24 scores back; conforming clients must accept zero to at least 24.

• If the event has a high score list, and the player has earned a high score now, the index (from 1 = first place) which was achieved.

Error Responses

An error response is of the form:

{ from: "endEvent",
  status: false,
  eventID: "event UUID",
  err: "error code",
  error: "User-visible error message" }

The error code can be one of:

cost

The item to be purchased costs more peanuts than you have.

badStatus

The status passed was not one of cmp nor cxl

eventID.notFound

The event ID passed was not found

eventID.notYours

The event ID passed represents an event started by another player

medal.notFound

The medal passed was not valid

score.range

The score reported was not valid; it was not in the range of possible scores for this event.

Changes from 1.2 to 2.0

WRITEME

File

Defined in file src/infinity/legacy-commands.lisp.